home *** CD-ROM | disk | FTP | other *** search
/ Mac Mania 4 / MacMania 4.toast / / Internet software / CallGrabber 1.1.2 / Read Me Please - Thanks! < prev   
Text File  |  1996-01-15  |  17KB  |  283 lines

  1.               CallGrabber 1.1.2
  2.                                     A Callerlog Analyzer for Second Sight....
  3. Foreword:
  4.  
  5. I urge Sysops to print this file out as a reference for when they set up CallGrabber.  The data file (discussed below) has a lot of variables that need to be setup for proper operation of this application and its handy to have a "scratch copy" of this "Read Me" on hand to make notes.  I have used a text data file because its a lot faster and easier to manage once it is set up.  The overhead of a larger application taking more memory to have a built in setup dialog interface for variables that only need to be setup once didn't seem like a good idea to me.  When upgrading from previous versions of CallGrabber, always read and print this file because some of the data fields change from time to time as I continue to improve this application.  You can also read further in the documentation under the title of "Upgrading" for a quick reference of what you need to do to upgrade from the previous version of the application.  You may want to read the System Requirements located at the end of this document.
  6.  
  7. What is it?
  8.  
  9. CallGrabber is an application for Second Sight that analyzes your Callerlog during a netmail or a nightly external launch of Second Sight and creates a nicely formatted activity report that you can use as a SYSTEMx.MSG or a readable text file for you and your users to enjoy with optional ANSI color output (see the below example for what the output looks like).  CallGrabber also lets you optionally reset and/or archive your Callerlog file.
  10.  
  11. Why Use It?
  12.  
  13. I have always felt that the Callerlog was a bit clumsy for Second Sight.  Yes, it provides detailed usage statics as you know, but often I have wondered: “How many new messages? How many calls at what speed? Total Calls?” and with the ability of Second Sight to have multi-nodes, this has become more confusing then ever.  After creating this application I can easily see a report of what kind of activity my system has been getting overall  without counting through a huge Callerlog and just getting a vague idea.  Also, looking though a huge Callerlog was not my idea of fun.
  14.  
  15. What The Output looks like:
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32. Above you can see the result of launching CallGrabber.   A nice ANSI output is presented (for those users who can support it) and for those who cannot, Second Sight’s excellent ANSI filter will remove the colors and the boarders for you.
  33.  
  34. How To Set It Up:
  35.  
  36. 1. Place CallGrabber and the CallGrabberData file in the same folder as your Second Sight application, it must be in the same folder as the BBS program to operate correctly.
  37.  
  38. 2. Using a text processor (SimpleText, RedWriter) open the CallGrabberData file, you will see something that looks like this:
  39.  
  40. 1
  41. Macintosh HD1:SSBBS:Callerlog
  42. Macintosh HD1:SSBBS:OldLogs:CallerLog.Arch
  43. Macintosh HD1:SSBBS:BBS System Files:SYSTEM2.MSG
  44. Macintosh HD1:SSBBS:Second Sight
  45.  [0;1;34;47mThe Final Nexus [0;30;47m
  46. Yesterday's
  47. 3
  48. 1
  49. 2
  50. 2
  51. 5
  52. 3
  53. 6
  54. 7
  55. 0
  56. 1
  57. 0
  58. 1
  59. 1
  60. 0
  61.  
  62. This file contains the variables and data that CallGrabber needs to operate, listed below are what each variable is; customize it to suit your needs.
  63.  
  64. 1                                               -Number of Callerlogs to Process
  65. Macintosh HD1:SSBBS:Callerlog                   -Path to Your Callerlog
  66. Macintosh HD1:SSBBS:OldLogs:Callerlog.Arch      -Where to save/append Calllog Archive
  67. Macintosh HD1:SSBBS:BBS System Files:SYSTEM2.MSG-Where to Save Output
  68. Macintosh HD1:SSBBS:Second Sight                -App to Launch When Done
  69.  [0;1;34;47mThe Final Nexus [0;30;47m           -Your BBS Name (ANSI Optional)
  70. Yesterday's                                     -First Word Greeting (ANSI Optional)
  71. 3                                               -Header/Time/Date Color
  72. 1                                               -ANSI Boarder Color
  73. 2                                               -Color of Header Titles
  74. 2                                               -Baud Rate Stats Color
  75. 5                                               -Connection Info Color
  76. 3                                               -Message Data Color
  77. 6                                               -File Transfer Data Color
  78. 7                                               -Misc. Information Color
  79. 0                                               -Background ANSI Color
  80. 1                                               -1=Output file has a clear screen
  81.                                                  0=Output file has no clear screen
  82. 0                                               -Number of days to search back in
  83.                                                  the Callerlog. If 0 then all days
  84. 1                                               -0=Do Not Archive or Reset Callerlog
  85.                                                 -1=Reset & Archive the Callerlog
  86.                                                 -2=Just Reset the Callerlog
  87. 1                                               -0=SimpleText/TeachText
  88.                                                 -1=CallGrabber File Icon
  89.                                                 -2=ClarisWorks
  90.                                                 -3=WordPerfect
  91. 0                                               -If You Register, your code goes
  92.                                                  here.  Otherwise, leave as 0.
  93.  
  94. •Please note that the “First Word Greeting” and “Your BBS Name” are in a combined string within CallGrabber in a format like this: [first word greeting] Usage for [your BBS name] Time/Date. This is provided if you want to use another application to run CallGrabber other then once a day; maybe you would like to run it once a month before resetting your Callerlog. You could then replace the word "Yesterday's" with "Last Month's".
  95.  
  96. •Please see the section below on Archiving/Resetting the Callerlog.
  97.  
  98. •The First variable is the total number of Callerlogs that CallGrabber will examine.  The next data string listed above as "Macintosh HD1:SSBBS:Callerlog" contains the path the the Callerlog.  If you have several callerlogs to process your data file might look something like this:
  99.  
  100. 3
  101. Macintosh HD1:SSBBS:Node I:Callerlog
  102. Macintosh HD1:SSBBS:Node II:Callerlog
  103. Macintosh HD1:SSBBS:Node III:Callerlog
  104. Macintosh HD1:SSBBS:OldLogs:Callerlog.Arch
  105. Macintosh HD1:SSBBS:BBS System Files:SYSTEM2.MSG
  106. Macintosh HD1:SSBBS:Second Sight
  107.  [0;1;34;47mThe Final Nexus [0;30;47m
  108. Yesterday's
  109. 3
  110. 1
  111. 2
  112. 2
  113. 5
  114. 3
  115. 6
  116. 7
  117. 0
  118. 1
  119. 0
  120. 1
  121. 1
  122. 0
  123.  
  124. ANSI Color Table for Above Variables
  125. 1 = Black
  126. 2 = Red
  127. 3 = Green
  128. 4 = Yellow
  129. 5 = Blue
  130. 6 = Magenta
  131. 7 = Cyan
  132. 8 = White
  133.  
  134. Archive/Reset the Callerlog:
  135.  
  136. New as of Version 1.1, CallGrabber has the ability to reset and/or archive your callerlog for you.  Even if you do not plan to use these features, the file path for archiving must be used as a "place holder" for the data file.
  137.  
  138. Currently the archive and reset routines are not "smart", they do not "know" where a day leaves off and a new one begins.  Your Callerlog will be reset totally (i.e. an empty file) and if you archive it, the total contents will be appended to the archive file.
  139.  
  140. All Callerlogs are appended to the archive file, there are not separate archive files for each of your Callerlog files.
  141.  
  142. Finally, if you are resetting your Callerlog using the above, you may (and should) enter a "0" for "Number of Days to Search Back in The Callerlog". Since you are resetting the Callerlog, CallGrabber doesn't have to search back for a number of days and this will speed up the processing of your Callerlog.
  143.  
  144. I HIGHLY RECOMMEND RESETTING AND ARCHIVING THE CALLERLOG!!!!  This is because the Callerlog is just a text file and processing a huge Callerlog takes time.  If you archive/reset the Callerlog you have the following benefits:
  145.  
  146. 1.  You can view your log as a whole, with every node appended.  This saves time by not having to look through X number of logs for one action.  Your favorite word processor can do it for you (i.e. Find Text).
  147.  
  148. 2.  CallGrabber will be faster.  By not having to look through a month or more of caller data the program will process in just a few seconds.
  149.  
  150. 3.  CallGrabber will set your logs to reflect your favorite Word Processor's text format; just a double-click is all it takes to open a log.
  151.  
  152. When To Use It:
  153.  
  154. Since everyone’s BBS is different, it is hard to say when to use CallGrabber.  If you are using a netmail application, then you might as well run CallGrabber at the same time as part of your nightly mail activities.  If your BBS runs some sort of maintenance utility that resets the Callerlog on a nightly basis, then you would want to have CallGrabber in the launch chain before your Callerlog is reset.  If CallGrabber is not your only timed utility, make sure that the next utility that you want to launch is the one specified in the “App to Launch When Done” string in the data file.
  155.  
  156. Note From The “Programmer”:
  157.  
  158. Thank you for taking the time to look at this, I hope it is a fine addition to your Bulletin Board System.  It has taken me hours and hours of work to get it just right, so if you like it please send me just $5 to the address below.  I’ll then keep you and your BBS on my list so you are the first to get the next version and any updates I may have for you.  Also you may send any bug reports to my contact information.  Most importantly it keeps me writing external applications for Second Sight and ensures that any comments or suggestions you have for CallGrabber or any application ideas gets top priority with me.
  159.  
  160. Sincerely,
  161.  
  162.  
  163.  
  164.  
  165.  
  166. Steve Major
  167.  
  168. Contact Information:
  169.  
  170. Steven Major
  171. P.O. Box 562
  172. Champlain, NY 12919
  173.  
  174. The Final Nexus BBS: 518-561-3002
  175. AOL: Steve Majo
  176. eWorld: Steve Major
  177. Internet: stevemajo@aol.com
  178.  
  179. Version History:
  180.  
  181. 1.0 - Initial Release.
  182.  
  183. 1.0.1 - A small update to include a couple of Callerlog checks that I forgot in the 1.0
  184.            release, corrected “Get Info” information, and a couple of extra error checks.
  185.  
  186. 1.0.2 - Added the ability to process up to 50 Callerlogs for Multi-node use.   Great input
  187.            from the master himself, Jeff Dripps.
  188.  
  189. 1.0.3 - Revised the "Baud Rate" data fields to correctly display the DCE rates that
  190.            Second Sight supports and not the DTE rates for the previous versions.
  191.            Because of space requirements and an extra DCE rate, the Local Host
  192.            information was moved to the Misc. Information box, but is still counted as a
  193.            "Connect".  Made the status box a little different and larger to display more
  194.            information in future releases.  Added code to prevent variables from being a
  195.            negative number (CallGrabber subtracts unsuccessful uploads/downloads and
  196.            other variables from the totals).
  197.  
  198. 1.0.4 - Added ability to change the background color and set a screen clear before the
  199.            output file is displayed.  Fixed the "Connects" field so variables can not be less
  200.            then a 0.  Input from Ray Leninger of MacHaven BBS.
  201.  
  202. 1.0.5 - Fixed a problem with the Host Error detection field, CallGrabber now correctly
  203.            reports host errors.  Added limited background operation support instead of
  204.            keeping all processor time to itself.  For those that use the multi-
  205.            Callerlog ability added in version 1.0.2, CallGrabber now displays Callerlog
  206.            file numbers as they are processed.  Added the DTE rates that were removed
  207.            from version 1.0.3 for some Sysops with false modem command strings and/or
  208.            lack of a correct modem cable that sometimes report DTE rates; Callgrabber
  209.            now takes a "best guess" of these DTE rates and adds them to the DCE rates
  210.            fields.  I became bored on a Sunday and created new icons for CallGrabber and
  211.            its output file, I hope you all like these better (rebuild your desktop to see 'em
  212.            if they don't show up!)
  213.  
  214. 1.0.6 - Fixed the "Get Info" box data.  Added another data field (see above) that lets a
  215.            Sysop specify the number of days back in a Callerlog to search for a file.  With
  216.            this feature those Sysops who do not use a utility that resets the Callerlog
  217.            from time to time may display only a few days (or daily) usage of their system.
  218.            Many thanks to Ray Leninger of MacHaven BBS for pointing me in the right
  219.            direction on programming this feature!
  220.  
  221. 1.0.7 - Removed the Default Color field from the Data File because with the addition of
  222.            the Background ANSI color introduced in version 1.0.4 it became redundant to
  223.            have a default color variable since the Background ANSI handles this aspect
  224.            any how.  Added some Call Events in the Main Loop of the program so
  225.            (hopefully) we will have better response time from BBS Nodes running in the
  226.            background while CallGrabber is processing.  Used a lot of what I learned with
  227.            the initial release of UserGrabber to generally cleanup CallGrabber's code and
  228.            make operation a bit better. Added the watch Cursor to replace the arrow cursor
  229.            while CallGrabber was doing it thing and added a new field called "Remote
  230.            Maint" so Sysops with Co-Sysops or Managers can see the activity of
  231.            those users.  With the new field added, I was able to move the "Local Host"
  232.            field back to the :Connects: column (it was moved in version 1.0.3).
  233.  
  234. 1.0.8 - Created a "top-down" text search for the variable strings.  In other words, CG
  235.            is more likely to find downloads/uploads and messages then connects and
  236.            other things, so now "most important" fields are checked first, skipping the
  237.            others until none are found.  This seemed to speed things up just a little
  238.            without adding any more code.  Added Registration Code process that will let
  239.            you turn off the "splash-line ad for my BBS".
  240.  
  241. 1.0.9 - Added a "Chat Conference" count in the "Messages" header for Sysop's using
  242.            Second Sight 3.5 as well as repaired the ANSI counter and the "number of days
  243.            back to start" locator that was broken by some changes in the new version.
  244.  
  245. 1.1.0 - Added a "Manual Backup" count in the "Misc Information" header to report
  246.            manual File Section, Userlog, and Message base backups.  Changed the "1200
  247.            Baud" Connect field to read "3/1200 Baud:" since we now count 300 baud
  248.            connects too and add them to the 1200 baud count.  Downloads and uploads
  249.            by Sysop's calling in remotely using the "Remote Maint. Commands" are now
  250.            counted in that field.  "Sys Maintenance" field now counts automatic maint.
  251.            events added in Second Sight 3.5.  Added options for Archiving and/or
  252.            resetting the Callerlog on a nightly basis.
  253.  
  254. 1.1.1 - Fixed the ANSI screen clear problem that caused the background color to be
  255.            black text on white when it should have been what the user selected in the
  256.            data files variable.  Added the ability to specify a word processor text type
  257.            and creator for simple double-clicking to open a log file. (If you don't see your
  258.            favorite word processor listed above, send me the type/creator signature or
  259.            a text file using the Save As command and it will be added in the next release.
  260.  
  261. 1.1.2 - Recompiled application for increased reliability and speed with System 7.5.x
  262.            and PowerPC Macs.
  263.  
  264. What Next?:
  265.  
  266. I still have a lot of utilities that I want to write for Second Sight. (Even CallGrabber
  267. still needs a little work).  Registering my applications will make this a reality.  Currently I've started finished work on BirthdayGrabber, a nightly utility for Second Sight 3.5 that makes use of the Birth-date fields and displays a text file at logon of your users birthday's in the current month.
  268.  
  269. Register CallGrabber:
  270.  
  271. If you are using CallGrabber, please register it.  I have many plans for Second Sight but they will not come true without incentive.  Register CallGrabber for only $5.  By registering CallGrabber, you will get a registration code that will enable you to turn off the splash-ad for my BBS as well as the ANSI line above it.
  272.  
  273. Upgrading:
  274.  
  275. If you are upgrading from version 1.1.1 of CallGrabber, you need to nothing except replace your 1.1.1 version of the CallGrabber Application with 1.1.2.
  276.  
  277. Distribution:
  278.  
  279. CallGrabber maybe freely uploaded to any Bulletin Board or On-Line service.  Shareware vendors may include CallGrabber in any or all of their Shareware bundles, providing that I am notified by E-Mail or In Writing of the plans to include CallGrabber.
  280.  
  281. System Requirements:
  282.  
  283. CallGrabber will work with Second Sight 3.0 or above and requires any Macintosh using System 7.0 or above with 512K available.  CallGrabber may also work with Second Sight 2.0, however it has not been tested and variables specific to version 3.0 will contain a "0" for the output.